home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / ATTIC201.ZIP;1 / ATTIC.HLP < prev    next >
Encoding:
Text File  |  1989-05-17  |  19.6 KB  |  839 lines
  1. ~322
  2.  
  3.  Documents to compare are either retrieved from the library or from
  4.  a disk file.
  5.  
  6.  If LOCation is "L" enter the name of a library text file.
  7.  
  8.  If LOCation is "D" enter a disk filename.
  9.  
  10.  Enter <F9> to enter SELECT option to view text names.
  11.  
  12.  Enter <esc> to backup.
  13.  
  14. `
  15.  
  16.  
  17.  
  18. ~1
  19.  Enter in the pathname of the file(s) that you wish to add the library.
  20.  The file(s) will be added to the library if either of the following
  21.  conditions are met.
  22.  
  23.    1) If no prior versions of the file exits in the library.
  24.  
  25.    2) The last modification date on the file is more recent than
  26.       the latest version in the library.
  27.  
  28.  The (?) and (*) wild card characters are supported in filenames and
  29.  extensions.  The (?) means that any character can occupy that position 
  30.  in a filename. The (*) means that any character can occupy that position
  31.  OR any of the remaining positions in the filename.
  32.  
  33.  Example:
  34.      *.doc - processes all files in the current directory with a doc ext.
  35.     a*.doc - processes all files in the current directory starting with
  36.              the letter a and with a .doc ext.
  37.      ?.*   - processes all one character files in current directory.
  38. `
  39. ~2
  40.  
  41.  A one line comment can be stored with each version of a text that
  42.  is added to the library.
  43.  
  44.  When processing multiple files with wild cards, a single comment can
  45.  be entered which is then stored with each Text added in that batch,
  46.  you can be prompted individually for comments for each Text as it is
  47.  added, or comment processing can be skipped for all file in the batch.
  48.  
  49.  Enter S:
  50.  
  51.     To be prompted for a single comment which will be applied to
  52.     all Texts added.
  53.  
  54.  Enter D:
  55.  
  56.     To be prompted for different comments for each Text.
  57.  
  58.  Enter N:
  59.  
  60.     To skip comment processing.        
  61. `            
  62.  
  63. ~200
  64.  
  65.  
  66.  The ADD function prompts for disk file pathname(s) and adds them to
  67.  the library.  Only files whose  modification date is greater than
  68.  the corresponding text library version date are added.
  69.  
  70.  To add files to the library unconditionally use the FORCE option in
  71.  the Utility menu.
  72.  
  73.  The use of <*> and <?> wild cards in pathnames is supported.
  74.  
  75.  
  76.  
  77. `
  78.  
  79. ~201
  80.  
  81.  The SELECT function is used to define a current text selection.
  82.  This selection can then be used in the Xtract, Keyword, Report 
  83.  and Deletion functions to process groups of texts.
  84.  
  85.  Text selection is made by first moving the cursor to highlight the
  86.  desired text and pressing the <+> key.  Pressing the <-> key 
  87.  unselects the highlighted text.  Pressing <F1> selects all texts,
  88.  pressing <F2> unselects all texts and <F3> toggles all selections.
  89.  
  90.  Typing the name of text jumps the cursor to that text. The arrow keys,
  91.  page_up and page_down move the cursor.
  92.  
  93.  Optionally, the SELECT function can be used to scroll through a 
  94.  library text on the screen by pressing <F4>.
  95.  
  96. `
  97. ~202
  98.  The KEYWORD function is used to maintain the association between
  99.  keywords and library texts.  Keywords can be used in the Extract, 
  100.  Delete and Report options to perform processing on groups of texts.  
  101.  
  102.  Keywords can be associated with a specific version or with the 
  103.  latest version of a text. This latter type of keyword association 
  104.  floats to the latest version of a text as new versions are added.
  105.  
  106.  To Add or Delete Keywords:
  107.     1) Define a current selection of texts using the SELECT option.
  108.     2) Select one of the following version modes using the 
  109.            VERSION option:
  110.         a) Last     - maintains floating (latest version) keywords.
  111.         b) All      - maintains keywords associated with any version.
  112.         c) Current  - maintains keywords of latest version.
  113.         d) Specific - maintains keywords for specific versions.    
  114.     3) Delete or Add Keywords.
  115.  
  116.   !NOTE: KEYWORD maintenance is performed only on selected texts
  117.          and their versions defined by the VERSION setting.       
  118. `
  119.  
  120. ~203
  121.  XTRACT retrieves text versions from a library and writes them to files
  122.  on disk.
  123.  
  124.  The text versions to be extracted can be identified by one of the 
  125.  following means:
  126.     
  127.     a) Current SELECTion and VERSION mode.
  128.  
  129.     b) KEYWORD
  130.  
  131.     c) A specified text and version.
  132.  
  133.  Full pathnames and wildcards <*> and <#> for output files are 
  134.  supported. The wild card <*> when used in place of a filename
  135.  or extension denotes the respective text name or text extension.
  136.  The wild card <#> when used in place of an extension is replaced
  137.  by the version number of the text being extracted.  This allows
  138.  extraction of multiple versions of a text using one command.
  139. `
  140. ~204
  141.  ATTIC provides the following two reports:
  142.  
  143.  1) HISTORY REPORT
  144.     
  145.       Displays version create date, library update date and
  146.       comments for all versions of selected texts.  The text 
  147.       selection for the report is based upon a current 
  148.       SELECTion, a defined Keyword or specified text.
  149.  
  150.  2) KEYWORD REPORT
  151.  
  152.       Displays listing of keywords and their associated
  153.       texts and/or versions.  Floating keywords are 
  154.       associated with version number <last>
  155.       for their respective texts.
  156.  
  157.       The report can be sorted by keyword or text.
  158.  
  159.  Report output from either the HISTORY or KEYWORD reports can be
  160.  directed to a screen or to an output file.
  161.  
  162. `
  163.  
  164. ~205
  165.  VERSION defines which versions of SELECTed texts are processed by 
  166.  the KEYWORD and XTRACT options. The VERSION mode can be set to one 
  167.  of the following four values:
  168.  
  169.      Last    - Denotes that the latest version, is to be processed. 
  170.                Keywords defined with this mode set are not associated 
  171.                with specific versions. Rather they "float" and 
  172.                associate with the latest text at any point in time.
  173.  
  174.      Current - Keywords are associated with the latest version.
  175.                In contrast to "Last",  if later versions are added, the 
  176.                keyword association does not "float" to the higher versions.
  177.  
  178.      All     - All versions are selected.  Used with KEYWORD and
  179.                XTRACT options.
  180.  
  181.     Specific - A single version number is selected.  Allows keywords
  182.                to be associated with specific versions.
  183. `
  184.  
  185. ~206
  186.  
  187.  COMPARE compares two files or texts and displays their differences 
  188.  highlighted on the screen. 
  189.  
  190.  The objects to be compared can reside either in the library or on
  191.  disk.
  192.  
  193.  When defining the objects to be compared you must specify whether 
  194.  their location is either in the <L>ibrary or on <D>isk.  For library
  195.  texts the version number and textname  is entered.  For disk files 
  196.  the appropriate pathname is entered. 
  197.  
  198.  
  199. `
  200. ~207
  201.  The Utility menu provides access to the following three options:
  202.  
  203.    1.  FORCE
  204.  
  205.        Unconditionally adds files to the library regardless of 
  206.        their date of last modification.  This is  in contrast, 
  207.        to the ADD option in the main menu which adds a file to the 
  208.        library only if its modification date is greater than the 
  209.        modification date of the latest version.
  210.  
  211.    2.  DELETE
  212.  
  213.        Deletes Texts or the current Library.  Text deletion can
  214.        be specified by current selection, specific text, or keyword.
  215.  
  216.    3.  Reorganize
  217.  
  218.        Recovers space in library files caused by deletions.
  219.  
  220. `
  221.  
  222. ~208
  223.  
  224.    Returns to main menu.
  225.  
  226. `
  227.  
  228. ~212
  229.  
  230.  Setting the Version mode to LAST  causes the Keyword Option to
  231.  create or delete "floating" keywords which always associate with
  232.  the latest version of a text.  Keywords defined in this manner
  233.  do not need to be redefined as newer versions of a text are added to
  234.  the library.  They always point to the "latest" version.
  235.  
  236.  Keywords defined with this mode appear on Keyword reports as being
  237.  associated with the version number "last" as opposed to any specific
  238.  version number.
  239.  
  240.  These keywords can be deleted only if the Version mode is set to LAST.
  241.  
  242. `
  243.  
  244. ~213
  245.  
  246.  Setting the Version mode to ALL has the following effects on
  247.  subsequent processing:
  248.  
  249.   1)  Any keywords added are associated with all versions of the 
  250.       selected texts.
  251.  
  252.   2)  Keywords associated with any version number of the selected
  253.       texts are deleted by KEYWORD delete. This mode will not allow 
  254.       deletion of "floating" keywords which always relate
  255.       to the latest version of a text.
  256.  
  257.   3)  Extracting library texts to disks under the current selection
  258.       option of the XTRACT function will process all versions. 
  259.  
  260.       (Be sure to use the <*> and/or <#> wildcards in defining the 
  261.       output filename to avoid attempting to overwrite the same disk 
  262.       file with multiple versions of the same text.)
  263. `
  264.  
  265. ~214
  266.  Setting the Version mode to CURRENT always selects the latest
  267.  version number when processing SELECTED texts in the XTRACT or
  268.  KEYWORD maintenance functions.  
  269.  
  270.  Under the CURRENT Version mode any keyword additions are 
  271.  assigned to the latest version of the selected texts. As later  
  272.  versions are added the associations of these keywords 
  273.  DO NOT "float" to the later versions.  This is in contrast
  274.  to the LAST Version mode.   
  275. ` 
  276.  
  277. ~215
  278.  
  279.  The SPECIFIC Version mode prompts for and sets the Version Mode 
  280.  to a single version number.
  281.  
  282.  The primary function of this mode is to facilitate the assignment
  283.  of keywords to prior versions of texts.
  284.  
  285.  
  286. `
  287.  
  288. ~216
  289.  
  290.  Return to Main Menu.
  291.  
  292. ' 
  293.  
  294. ~217
  295.  
  296.     
  297.  
  298.       The KEYWORD report displays keywords and their  
  299.       associated library texts and/or versions.  
  300.  
  301.       Version number <last> denotes floating keyword.
  302.  
  303.       The report can be sorted by keyword or text.
  304.  
  305.       Report output can be directed to the screen or an output file.
  306.  
  307.  
  308. `
  309.  
  310. ~218
  311.  
  312.     
  313.       The HISTORY report displays file create date, 
  314.       library update date and comments. 
  315.       
  316.       Text selection for the report is based upon a 
  317.       Current Selection, an entered Keyword or a specified 
  318.       text.
  319.  
  320.       Report output can be directed to the screen or an 
  321.       output file.
  322.  
  323.  
  324. `
  325.  
  326.  
  327. ~219
  328.  
  329.  Return to main menu
  330.  
  331. `
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338. ~301
  339.  
  340.  
  341.   Enter in a pathname, without extension, for an existing library or 
  342.   for a library that you wish to create.
  343.  
  344.   The filename can be no more than 7 characters.  The file 
  345.   extension if entered is ignored.
  346.  
  347.   <esc> exits the program and returns to MSDOS.
  348.  
  349. `
  350. ~302
  351.  
  352.    The library you entered above cannot be found.
  353.  
  354.  
  355.    Enter <Y> to create a new library with this name.  
  356.  
  357.    Enter <N> to re-prompt for the name of a library.
  358.    
  359.    Enter <esc> to return to MSDOS.
  360.  
  361.  
  362.    An ATTIC library consists of the following set of 5 files,
  363.    where xxxxxxx is the entered library name.
  364.  
  365.         xxxxxxT.ATK - Contains text specific information.
  366.        xxxxxxV.ATK - Contains version specific information.
  367.         xxxxxxS.ATK - Contains segment specific information.    
  368.         xxxxxxL.ATK - Contains texts. 
  369.         xxxxxxK.ATK - Contains keywords.
  370. `
  371. ~50
  372.  
  373.   The HISTORY report can include all Currently selected texts, texts
  374.   assigned to a Keyword or a specific Text.
  375.  
  376.   Enter <C> to report on currently selected texts.
  377.  
  378.   Enter <K> to report on texts associated with a given keyword.
  379.  
  380.   Enter <T> to report on a specific text.
  381.  
  382.   Enter <esc> to exit function.
  383.  
  384.  
  385. `
  386.  
  387. ~50
  388.  
  389.  
  390.  
  391.     Enter the name of the text on which you wish to report.
  392.  
  393.     Enter <esc> to backup.
  394.  
  395.  
  396.  
  397. `
  398.  
  399. ~52
  400.  
  401.  
  402.  
  403.  
  404.   Enter in a keyword to select texts on which to report.
  405.   
  406.   Enter <esc> to backup.
  407.  
  408.  
  409. `
  410.   
  411. ~905
  412.   The SELECT option  selects text(s) for the purpose of adding 
  413.   keywords, extracting to disk, and history reporting.
  414.  
  415.   Enter <esc> to complete selections and exit function.
  416.  
  417.   Enter <+> to select text.
  418.  
  419.   Enter <-> to unselect text
  420.  
  421.   Enter <F1> to select all texts.
  422.  
  423.   Enter <F2> to unselect all texts.
  424.  
  425.   Enter <F3> to toggle text selections.
  426.  
  427.   Enter <F4> to display highlighted text.
  428.  
  429.   Enter <right arrow>, <left arrow>, <pgup>, <pgdn>, <down arrow> or
  430.         <up arrow> to move cursor.
  431. `    
  432.   
  433. ~206
  434.  
  435.     Enter version number of text to display.
  436.  
  437.         <cr> selects latest version.
  438.  
  439.         <esc> backs up.
  440.  
  441. `
  442. ~21
  443.  
  444.    Texts can be selected for extraction to disk on the basis
  445.    of the current SELECTion, Keyword, or a specific Text.
  446.  
  447.  
  448.    Enter <C> to extract currently selected texts.
  449.  
  450.    Enter <K> to extract based upon a defined keyword.
  451.  
  452.    Enter <T> to extract a specific text.
  453.  
  454.    Enter <esc> to exit function.
  455.  
  456. `
  457.  
  458. ~22
  459.  
  460.      The file to be extracted already exists on disk. 
  461.  
  462.      Enter <Y> to overwrite the existing file.
  463.  
  464.      Enter <N> to skip the extraction of that file.
  465.  
  466.      Enter <esc> to skip the extraction of the file and
  467.            exit function.
  468.  
  469.     ! note:
  470.  
  471.          When extracting on the basis of a current selection
  472.          with a Version setting of ALL, or extracting with a
  473.          keyword associated with multiple versions of a text,
  474.          using the <#> wild card as an extension will
  475.          create multiple versions on disk using the version
  476.          number as an extension. 
  477. '         
  478.  
  479.      
  480. ~23
  481.  
  482.       Enter the name of the text to extract to disk.
  483.  
  484.       Enter <esc> to backup.
  485.  
  486. `
  487. ~24
  488.  
  489.       Enter the version number of the text to
  490.       extract.
  491.  
  492.       Enter <cr> to select latest version.
  493.  
  494.       Enter <esc> to backup.
  495.  
  496. `
  497. ~26
  498.  
  499.  
  500.      Enter a keyword which has been associated with one
  501.      or more texts.  These texts will then be extracted
  502.      to disk.
  503.  
  504.      Enter <esc> to backup.
  505.  
  506.  
  507. `
  508.  
  509. ~28
  510.  
  511.   The Version Mode is set to ALL.  The default output file
  512.   name is the textname with a version number extension.
  513.  
  514.   Enter <cr> to accept the default.
  515.  
  516.   Enter another path and/or filename.
  517.  
  518.   Enter <esc> to backup.
  519.  
  520.      Note!
  521.  
  522.       When extracting multiple files at a time it is recommended
  523.       the wildcards <*> and/or <#> be used to avoid attempted
  524.       file overwrites on disk.
  525.  
  526.       The <*> is replaced by the textname and/or extension.
  527.        
  528.       The <#> when entered as an extension is replaced by the
  529.       text's version number.
  530. '
  531.  
  532.  
  533. ~29
  534.   The default extracted filename is the textname and its extension
  535.   as denoted by the *.* wild card.
  536.  
  537.     Enter <cr> to accept the default.
  538.  
  539.     Enter another path and/or filename and extension.
  540.  
  541.     Enter <esc> to backup.
  542.  
  543.      Note!
  544.  
  545.       When extracting multiple files at a time it is recommended
  546.       the wildcards <*> and/or <#> be used to avoid attempted
  547.       file overwrites on disk.
  548.  
  549.       The <*> is replaced by the text name and/or extension.
  550.        
  551.       The <#> when entered as an extension is replaced by the
  552.       text's version number.
  553. `
  554.   
  555. ~60
  556.  
  557.   Enter <L> to delete the current library.  This will delete the
  558.           ENTIRE LIBRARY you have open, including all of its texts.
  559.             The process will then exit to the system.  Be careful
  560.             with this option; it deletes ALL TEXTS.
  561.  
  562.  Enter <C> to delete currently selected Texts.  This process will
  563.            delete all selected texts regardless of the Version Mode
  564.            setting.
  565.  
  566.  Enter <T> to delete a specific text.  You will then be prompted for
  567.            the name of the text to delete.
  568.  
  569.  Enter <esc> to abort any deletes, and exit the function.
  570.  
  571.  
  572. `
  573. ~62
  574.          
  575.    Enter <Y> to confirm that you wish to delete the current
  576.             library and all of its texts.  This is your last 
  577.              chance.
  578.  
  579.    Enter <esc> or <N> to abort delete.
  580.  
  581. `
  582.  
  583. '4
  584.  
  585.    Enter a comment to be stored with all texts that will be added.
  586.  
  587.    Enter <cr> to skip the comment.
  588.  
  589.    Enter <esc> to backup.
  590.  
  591. `
  592.            
  593. ~7
  594.  
  595.  
  596.  
  597.   Enter a keyword to be associated with the selected texts.
  598.         The keyword can be up to 23 characters long.
  599.  
  600.   Enter <esc> to exit.      
  601.  
  602.  
  603.  
  604. `
  605. ~10
  606.  
  607.   Enter a beginning range of keywords to delete.
  608.  
  609.   Enter <cr> to select the first keyword for SELECTed
  610.   texts.
  611.  
  612.   Enter <esc> to exit function.
  613.  
  614. `
  615. ~11
  616.  
  617.   Enter the ending range of keywords.
  618.  
  619.   If no beginning range was entered an entry of
  620.   <cr> sets the ending range to the last keyword in the
  621.   file.
  622.  
  623.   If a beginning range was entered an entry of <cr> makes the
  624.   beginning and ending range the same to facilitate the deletion
  625.   of a specific keyword.
  626.  
  627.   Enter <esc> to backup.
  628.  
  629. `
  630.   
  631. ~12
  632.  
  633.  
  634.   Enter <Y> to confirm delete.
  635.   
  636.   Remember the keywords selected for deletion is a function of:
  637.  
  638.    1) the range of keywords entered.
  639.  
  640.    2) the texts currently selected.
  641.  
  642.    3) the version mode.
  643.  
  644.  
  645.   Enter <esc> to backup.
  646.  
  647.  
  648.  
  649. `   
  650. ~6
  651.  
  652.   Enter a comment to be stored with the text.
  653.  
  654.   Enter <cr> to skip comment entry.
  655.  
  656.   Enter <esc> to abort file add.
  657.  
  658. `
  659.  
  660. ~101
  661.  
  662.   Enter <D> to select file for compare from disk file.
  663.  
  664.   Enter <L> to select file for compare from library text.
  665.  
  666.   Enter <esc> to backup.
  667.  
  668.  
  669.   
  670. `
  671.  
  672. ~102
  673.  
  674.   Enter version number of library file to compare.
  675.  
  676.   Enter <cr> to select latest version of library file.
  677.  
  678.   Enter <esc> to exit.
  679.  
  680. `
  681.  
  682. ~30
  683.  
  684.   The keyword report can be sorted by keyword or text name.
  685.  
  686.   Enter <K> to sort by keyword.
  687.  
  688.   Enter <T> to sort by text.
  689.  
  690.   Enter <esc> to exit function.
  691.  
  692. `
  693.  
  694. ~31
  695.  
  696.   Enter beginning range of texts to include in the report.
  697.  
  698.   Enter <cr> to select first text.
  699.  
  700.   Enter <esc> to exit.
  701.  
  702. `
  703.  
  704. ~32
  705.  
  706.   Enter the ending range of texts to select.
  707.  
  708.   If a beginning range was entered the ending range defaults to
  709.   the beginning range to facilitate report generation for a specific
  710.   text.
  711.  
  712.   If a beginning range was not entered the ending range defaults to
  713.   the last text in the library.
  714.  
  715.   Enter <cr> to select default.
  716.  
  717.   Enter <esc> to exit.
  718.  
  719. `
  720.  
  721. ~33
  722.  
  723.   Enter beginning range of keywords to include in the report.
  724.  
  725.   Enter <cr> to select first keyword.
  726.  
  727.   Enter <esc> to exit.
  728.  
  729.  
  730.  
  731. `
  732.  
  733. ~34
  734.  
  735.   Enter the ending range of keywords to include in report.
  736.  
  737.   If a beginning range was entered the ending range defaults to
  738.   the beginning range to facilitate report generation for a specific
  739.   keyword.
  740.  
  741.   If a beginning range was not entered the ending range defaults to
  742.   the last keyword in the library.
  743.  
  744.   Enter <cr> to select default.
  745.  
  746.   Enter <esc> to exit.
  747.  
  748. `
  749.  
  750. ~40
  751.  
  752.    Enter <Y> or <cr> to send output to the screen.
  753.  
  754.    Enter <N> to send output to a disk file.
  755.  
  756.    Enter <esc> to backup.
  757.  
  758. `
  759.  
  760. ~41
  761.  
  762.   Enter <cr> to select default output filename.
  763.  
  764.   Enter in output filename.
  765.  
  766.   Enter <esc> to backup.
  767.  
  768. `
  769. ~220
  770.  
  771.  
  772. Add keywords for selected texts
  773.  
  774. `
  775.  
  776. ~221
  777.  
  778. Delete Keywords for selected texts
  779.  
  780. `
  781.  
  782. ~222
  783.  
  784. Exit
  785. `
  786.  
  787. ~223 
  788.  
  789.  
  790.   
  791.  
  792.        Force adds files to the library regardless of their date of 
  793.        last modification.  In comparison, the Add option in the main 
  794.        menu adds a file to the library only if its modification date 
  795.        is greater than the modification date of the latest version
  796.        of the respective text in the library.
  797.  
  798. `
  799.  
  800. ~224
  801.  
  802.        Deletes texts or the current library.  
  803.  
  804.        Text deletion can be specified by current 
  805.        selection, specific text, or keyword.
  806. `
  807.  
  808. ~225
  809.  
  810.        Reorganize recovers space in library files caused 
  811.        by text deletions.
  812.  
  813. `
  814.  
  815. ~226 
  816.  
  817.        return to main menu
  818. `
  819.  
  820.  
  821. ~401
  822.  
  823.  Enter in the pathname of the file(s) that you wish to add the library.
  824.  
  825.  The file(s) will be unconditionally added to the library.
  826.  
  827.  The (?) and (*) wild card characters are supported in filenames and 
  828.  extensions.  The (?) means that any character can occupy that position 
  829.  in a filename. The (*) means that any character can occupy that position
  830.  OR any of the remaining positions in the filename.
  831.  
  832.  Example:
  833.      *.doc - processes all files in the current directory with a doc ext.
  834.  
  835.     a*.doc - processes all files in the current directory starting with
  836.              the letter a and with a .doc ext.
  837.      ?.*   - processes all one character files in current directory.
  838.         
  839. `